(logo)  AWeb ARexx Commands

Currently a very rudimentary command set is implemented. More commands will be added in the future.

Alphabetical overview

ACTIVATEWINDOW
ALLOWCMD
CLOSE          FORCE/S
GET            ITEM/A,VAR/K
NEW            URL/A,RELOAD/S
OPEN           URL/A,RELOAD/S
QUIT           FORCE/S
RELOAD
SAVEAS         NAME/A,APPEND/S
SCREENTOBACK
SCREENTOFRONT
WAIT           DOC=DOCUMENT/S,IMG=IMAGES/S,ALL/S
WINDOWTOBACK
WINDOWTOFRONT

Transfer commands

OPEN URL/A,RELOAD/S
Retrieve and show the document for this URL.
The RELOAD switch will reload the document even it is still in the cache.

NEW URL/A,RELOAD/S
Open a new window. Retrieve and show the document for this URL in the new window.
The RELOAD switch will reload the document even it is still in the cache.

The reserved variable RESULT will contain the port name of the new window.

RELOAD
Reload the current document.

WAIT DOC=DOCUMENT/S,IMG=IMAGES/S,ALL/S
Wait for transfer completion.
ALL Wait for transfers in all windows and background. Without the ALL switch this command waits only for transfers related to the addressed window.
DOCUMENT Wait for document transfer only, no inlined images or downloads.
IMAGES Wait for transfer of inlined images only.
DOCUMENT and IMAGES may be combined. With no DOCUMENT or IMAGES specified, the command waits for all transfers.

SAVEAS NAME,APPEND/S
Save the HTML source of the document.

If NAME is given, the source is saved under this name. If the APPEND switch is set, the source is appended to the file, otherwise the file will be overwritten.

If no NAME is given, a save requester will pop up.

Information retrieval commands

GET ITEM/A,VAR/K
Get information from the document in this window. The ITEM argument determines the information to return:
URL
Retrieve the URL of the document.
SOURCE
Retrieve the HTML source of the document. Note that due to an ARexx limitation only the first 65535 bytes are returned.
TITLE
Retrieve the title of the document. If no title was defined in the document, the document's URL is returned.
SCREEN
Retrieve the name of the screen that AWeb uses to open its windows on.
ACTIVEPORT
Retrieve the name of the ARexx port associated with the most recently activated AWeb window. Useful in ARexx macros started via a shell script or shell command to find the active window.

The information is returned in the reserved variable RESULT, unless the VAR argument is used to specify the variable name.

Control commands

ALLOWCMD
Temporarily allow shell commands and ARexx macros to be started from hyperlinks regardless of the Allow shell commands setting. This allows easier usage of ARexx plug-ins without need for the user to explicitly change the settings.

Commands are allowed only in the current document, or in the document that is being loaded. After a new document is loaded in the window, the normal settings apply.

ACTIVATEWINDOW
Make this window the active window.

WINDOWTOFRONT
Move this window in front of all other windows on the screen.

WINDOWTOBACK
Move this window to the back of all other windows on the screen.

SCREENTOFRONT
Move the screen that AWeb is using in front of all other screens.

SCREENTOBACK
Move the screen that AWeb is using to the back of all other screens.

CLOSE FORCE/S
Close this window.
The FORCE switch suppresses the "Are you sure" requester if this was the last window.

QUIT FORCE/S
Quit AWeb.
The FORCE switch suppresses the "Are you sure" requester.

<-Ports   ^ARexx   ->Return codes